Node.js Logging

Node.js

কেন নিবন্ধন গুরুত্বপূর্ণ

কার্যকরী নিবন্ধন বিভিন্ন কারণে অপরিহার্য:

ডিবাগিং

আপনার অ্যাপের ভিতরে কী ঘটছে তা বুঝুন

সমস্যা সমাধান

উৎপাদন পরিবেশে সমস্যা নির্ণয় করুন

পর্যবেক্ষণ

অ্যাপ্লিকেশন স্বাস্থ্য এবং কর্মক্ষমতা নিরীক্ষণ

সেন্সরশিপ

রেকর্ড কী সম্মতি এবং নিরাপত্তা ঘটনা

বিশ্লেষণ

অ্যাপ ব্যবহার এবং আচরণ সম্পর্কে ডেটা সংগ্রহ করুন

কনসোলের মাধ্যমে বেসিক লগিং

Node.js :

// Basic logging
console.log('Info message');
console.error('Error message');
console.warn('Warning message');
console.debug('Debug message');

// Log objects
const user = { id: 1, name: 'John', roles: ['admin', 'user'] };
console.log('User object:', user);

// Table output for arrays or objects
console.table([
  { name: 'John', age: 30, role: 'admin' },
  { name: 'Jane', age: 25, role: 'user' },
  { name: 'Bob', age: 40, role: 'guest' }
]);

// Timing operations
console.time('operation');
// Perform some operations...
for (let i = 0; i < 1000000; i++) {
  // Do something
}
console.timeEnd('operation'); // Outputs: operation: 4.269ms

// Grouping related logs
console.group('User Processing');
console.log('Loading user data...');
console.log('Validating user...');
console.log('Updating user profile...');
console.groupEnd();

// Stack trace
console.trace('Trace message');

কনসোলের সীমাবদ্ধতা

যদিও কনসোল সুবিধাজনক, এটি উত্পাদন ব্যবহারের জন্য উল্লেখযোগ্য সীমাবদ্ধতা রয়েছে:

ফিল্টারিংয়ের জন্য কোনো বিল্ট-ইন লগ লেভেল নেই
কোন রেকর্ড ঘূর্ণন বা ফাইল ব্যবস্থাপনা
JSON এর মত কোন কাঠামোগত আউটপুট ফরম্যাট নেই
মনিটরিং সিস্টেমের সাথে সীমিত একীকরণ

⚠️দ্রষ্টব্য:

টার্মিনাল/ফাইলগুলিতে আউটপুট করার সময় কনসোল মোডগুলি অ্যাসিঙ্ক্রোনাস হয় এবং উত্পাদনে ঘন ঘন ব্যবহার করা হলে কর্মক্ষমতা প্রভাবিত করতে পারে।

স্ট্রাকচার্ড রেজিস্ট্রেশন

স্ট্রাকচার্ড লগ ফরম্যাট লগ মেসেজগুলিকে প্লেইন টেক্সটের পরিবর্তে ডেটা অবজেক্ট (সাধারণত JSON) হিসাবে ফর্ম্যাট করে, তাদের পার্স, অনুসন্ধান এবং বিশ্লেষণ করা সহজ করে তোলে।

স্ট্রাকচার্ড লগিং এর সুবিধা

মেশিন পড়ার জন্য অভিন্ন বিন্যাস
আরও ভাল অনুসন্ধান এবং ফিল্টারিং ক্ষমতা
লগ ইন্টিগ্রেশন টুলের সাথে সরলীকৃত ইন্টিগ্রেশন
মেটাডেটা সহ উন্নত পরিবেশ

স্ট্রাকচার্ড লগ ইনপুটের উদাহরণ (JSON)

{
  "timestamp": "2023-11-28T15:24:39.123Z",
  "level": "error",
  "message": "Failed to connect to database",
  "service": "user-service",
  "context": {
    "requestId": "req-123-456",
    "userId": "user-789",
    "databaseHost": "db.example.com"
  },
  "error": {
    "name": "ConnectionError",
    "message": "Connection refused",
    "stack": "..."
  }
}

জনপ্রিয় Node.js রেজিস্ট্রি লাইব্রেরি

Winston

উইনস্টন একটি বহুমুখী লগিং লাইব্রেরি যা একাধিক পরিবহনের (আউটপুট) সমর্থন সহ

বেসিক উইনস্টন সিস্টেম

const winston = require('winston');

// Create a logger
const logger = winston.createLogger({
  level: 'info',
  format: winston.format.json(),
  defaultMeta: { service: 'user-service' },
  transports: [
    // Write logs to a file
    new winston.transports.File({ filename: 'error.log', level: 'error' }),
    new winston.transports.File({ filename: 'combined.log' }),
  ],
});

// If not in production, also log to the console
if (process.env.NODE_ENV !== 'production') {
  logger.add(new winston.transports.Console({
    format: winston.format.simple(),
  }));
}

// Usage
logger.log('info', 'Hello distributed log files!');
logger.info('Hello again distributed logs');
logger.error('Something went wrong', { additionalInfo: 'error details' });

কাস্টম উইনস্টন প্যাটার্নস

const winston = require('winston');
const { format } = winston;
const { combine, timestamp, label, printf } = format;

// Custom format
const myFormat = printf(({ level, message, label, timestamp }) => {
  return `${timestamp} [${label}] ${level}: ${message}`;
});

const logger = winston.createLogger({
  format: combine(
    label({ label: 'API Service' }),
    timestamp(),
    myFormat
  ),
  transports: [
    new winston.transports.Console(),
    new winston.transports.File({ filename: 'combined.log' })
  ]
});

logger.info('Application started');

Pino

পিনো সর্বোত্তম কর্মক্ষমতা সহ একটি নিম্ন-ওভারহেড রেকর্ডার হিসাবে ডিজাইন করা হয়েছে:

বেসিক পিনো সিস্টেম

const pino = require('pino');

// Create a logger
const logger = pino({
  level: 'info',
  timestamp: pino.stdTimeFunctions.isoTime,
  base: { pid: process.pid, hostname: require('os').hostname() }
});

// Usage
logger.info('Application started');
logger.info({ user: 'john' }, 'User logged in');
logger.error({ err: new Error('Connection failed') }, 'Database connection error');

এক্সপ্রেস সহ পিনো

const express = require('express');
const pino = require('pino');
const pinoHttp = require('pino-http');

const app = express();
const logger = pino();
const httpLogger = pinoHttp({ logger });

// Add request logging middleware
app.use(httpLogger);

app.get('/', (req, res) => {
  req.log.info('User accessed homepage');
  res.send('Hello World!');
});

app.get('/error', (req, res) => {
  req.log.error('Something went wrong');
  res.status(500).send('Error!');
});

app.listen(8080, () => {
  logger.info('Server started on port 8080');
});

Bunyan

বুনিয়ান হল লগ দেখার জন্য একটি CLI সহ একটি কাঠামোবদ্ধ লগিং লাইব্রেরি:

বেসিক বুনিয়ান সিস্টেম

const bunyan = require('bunyan');

// Create a logger
const logger = bunyan.createLogger({
  name: 'myapp',
  streams: [
    {
      level: 'info',
      stream: process.stdout
    },
    {
      level: 'error',
      path: 'error.log'
    }
  ],
  serializers: bunyan.stdSerializers
});

// Usage
logger.info('Application started');
logger.info({ user: 'john' }, 'User logged in');
logger.error({ err: new Error('Connection failed') }, 'Database connection error');

অ্যাপ্লিকেশন লগিং সেরা অভ্যাস

নিবন্ধন স্তর

লগ বার্তাগুলির গুরুত্ব এবং জরুরিতা শ্রেণীবদ্ধ করতে উপযুক্ত লগ স্তরগুলি ব্যবহার করুন:

অবস্থা ব্যাখ্যা
error রানটাইম ত্রুটি, ব্যতিক্রম, এবং ব্যর্থতা যে মনোযোগ প্রয়োজন
warn সতর্কতা শর্ত যা অ্যাপ্লিকেশন বন্ধ করে না কিন্তু সম্ভাব্য সমস্যা নির্দেশ করে
info অ্যাপ্লিকেশন ইভেন্ট এবং মাইলফলক সম্পর্কে তথ্যপূর্ণ বার্তা
debug বিস্তারিত ডায়গনিস্টিক তথ্য বিকাশের সময় দরকারী
trace আরো বিস্তারিত ডিবাগিং তথ্য (পদ্ধতি এন্ট্রি/প্রস্থান, পরিবর্তনশীল মান)

কি নিবন্ধন করতে হবে

নিবন্ধন করতে:

  • অ্যাপ্লিকেশন শুরু/স্টপ ইভেন্ট
  • স্বীকৃতি এবং স্বীকৃতি ইভেন্ট
  • API অনুরোধ এবং প্রতিক্রিয়া
  • ডাটাবেস অপারেশন এবং কর্মক্ষমতা মেট্রিক্স
  • প্রাসঙ্গিক ত্রুটি এবং ব্যতিক্রম
  • সম্পদ ব্যবহার এবং কর্মক্ষমতা মেট্রিক্স
  • কাঠামোগত পরিবর্তন

নিবন্ধন করবেন না:

  • পাসওয়ার্ড, টোকেন, API কী বা অন্যান্য শংসাপত্র
  • যথাযথ সুরক্ষা ছাড়াই ব্যক্তিগতভাবে সনাক্তযোগ্য তথ্য (PII)
  • ক্রেডিট কার্ড নম্বর, সামাজিক নিরাপত্তা নম্বর, বা অন্যান্য সংবেদনশীল ডেটা
  • সেশন আইডি বা কুকিজ
  • এনক্রিপশন কী

প্রসঙ্গ রেকর্ড

সমস্যা সমাধানের সুবিধার্থে প্রতিটি লগ এন্ট্রিতে সংশ্লিষ্ট প্রসঙ্গ যোগ করুন:

const winston = require('winston');

// Create a base logger
const logger = winston.createLogger({
  level: 'info',
  format: winston.format.json(),
  transports: [new winston.transports.Console()]
});

// Create a child logger with request context
function createRequestLogger(req) {
  return logger.child({
    requestId: req.id,
    method: req.method,
    url: req.url,
    ip: req.ip,
    userId: req.user ? req.user.id : 'anonymous'
  });
}

// Usage in Express middleware
app.use((req, res, next) => {
  req.id = generateRequestId();
  req.logger = createRequestLogger(req);
  req.logger.info('Request received');

  const start = Date.now();

  res.on('finish', () => {
    const duration = Date.now() - start;
    req.logger.info({
      statusCode: res.statusCode,
      duration: duration
    }, 'Request completed');
  });

  next();
});

function generateRequestId() {
  return Date.now().toString(36) + Math.random().toString(36).substring(2);
}

লগ ব্যবস্থাপনা এবং বিশ্লেষণ

নিবন্ধন চক্র

লগ ঘূর্ণন সক্ষম করে লগ ফাইলগুলিকে খুব বড় হতে বাধা দিন:

ঘূর্ণায়মান ফাইল পরিবহনের সাথে উইনস্টন

const winston = require('winston');
require('winston-daily-rotate-file');

const transport = new winston.transports.DailyRotateFile({
  filename: 'application-%DATE%.log',
  datePattern: 'YYYY-MM-DD',
  zippedArchive: true,
  maxSize: '20m',
  maxFiles: '14d'
});

const logger = winston.createLogger({
  level: 'info',
  format: winston.format.json(),
  transports: [
    transport,
    new winston.transports.Console()// Optional console transport
  ]
});

logger.info('Hello rotated logs');

কেন্দ্রীভূত নিবন্ধন

একাধিক সার্ভার বা পাত্রে চলমান অ্যাপ্লিকেশনগুলির জন্য, সহজ বিশ্লেষণের জন্য আপনার লগগুলিকে কেন্দ্রীভূত করুন:

ইলাস্টিক সার্চ ট্রাফিক সহ উইনস্টন

const winston = require('winston');
require('winston-elasticsearch');

const esTransportOpts = {
  level: 'info',
  clientOpts: {
    node: 'http://localhost:9200'
  },
  indexPrefix: 'app-logs'
};

const logger = winston.createLogger({
  transports: [
    new winston.transports.Elasticsearch(esTransportOpts),
    new winston.transports.Console()// Optional console transport
  ]
});

logger.info('This log will go to Elasticsearch');

জনপ্রিয় রেকর্ড ম্যানেজমেন্ট সিস্টেম

ELK Stack (Elasticsearch, Logstash, Kibana):ব্যাপক লগ স্টক
Graylog:নিরাপত্তার উপর ফোকাস সহ কেন্দ্রীভূত লগ ব্যবস্থাপনা
Fluentd/Fluent Bit:রেকর্ড সংগ্রহ এবং প্রেরণ
Loki:সহজ নিবন্ধন ইন্টিগ্রেশন সিস্টেম
ব্যবসার বিকল্প: Datadog, New Relic, Splunk, LogDNA, Loggly

উৎপাদনে নিবন্ধন

কর্মক্ষমতা বিবেচনা

ইভেন্ট লুপ ব্লক করা এড়াতে অ্যাসিঙ্ক্রোনাস লগিং ব্যবহার করুন
সেরা কর্মক্ষমতা জন্য বাফার লগ
উৎপাদনে ভলিউম কমাতে লগ লেভেল সামঞ্জস্য করুন
প্রতিটি ইভেন্ট রেকর্ড করার পরিবর্তে উচ্চ-ভলিউম রেকর্ডিংয়ের নমুনা নিন

নিরাপত্তা বিবেচনা

রেকর্ড করার আগে সংবেদনশীল ডেটা পরিষ্কার করুন
যথাযথ অনুমতি সহ লগ ফাইলগুলি সুরক্ষিত করুন
লগ পাঠানোর সময় এনক্রিপশন ব্যবহার করুন
লগ ডেটার জন্য ধারণ নীতি প্রয়োগ করুন
প্রাসঙ্গিক প্রবিধান (GDPR, HIPAA, ইত্যাদি) মেনে চলছে কিনা তা পরীক্ষা করুন।

ডেটা পরিষ্কারের উদাহরণ

const winston = require('winston');

// Custom format to sanitize sensitive data
const sanitizeFormat = winston.format((info) => {
  if (info.user && info.user.password) {
    info.user.password = '[REDACTED]';
  }

  if (info.user && info.user.creditCard) {
    info.user.creditCard = '[REDACTED]';
  }

  if (info.headers && info.headers.authorization) {
    info.headers.authorization = '[REDACTED]';
  }

  return info;
});

const logger = winston.createLogger({
  format: winston.format.combine(
    sanitizeFormat(),
    winston.format.json()
  ),
  transports: [
    new winston.transports.Console()
  ]
});

// This sensitive data will be sanitized in the logs
logger.info({
  message: 'User registered',
  user: {
    name: 'John',
    email: 'john@example.com',
    password: 'secret123',
    creditCard: '4111-1111-1111-1111'
  },
  headers: {
    authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
  }
});

লগ দিয়ে ডিবাগিং

ডিবাগ মডিউল

ডিবাগ মডিউল শর্তসাপেক্ষ ডিবাগ লগিং যোগ করার একটি সহজ উপায় প্রদান করে:

const debug = require('debug');

// Create named debuggers
const dbDebug = debug('app:db');
const apiDebug = debug('app:api');
const authDebug = debug('app:auth');

// Usage
dbDebug('Connected to database');
apiDebug('API request received at /users');
authDebug('User authenticated: %o', { id: 123, roles: ['admin'] });

// Enable with environment variable:
// DEBUG=app:* node app.js
// or
// DEBUG=app:db,app:auth node app.js

পরিচিতি আইডি

যোগাযোগ আইডি ব্যবহার করে একাধিক পরিষেবা জুড়ে অনুরোধ ট্র্যাক করুন:

const express = require('express');
const { v4: uuidv4 } = require('uuid');
const winston = require('winston');
const app = express();

// Create a logger
const logger = winston.createLogger({
  transports: [new winston.transports.Console()],
  format: winston.format.combine(
    winston.format.timestamp(),
    winston.format.json()
  )
});

// Correlation ID middleware
app.use((req, res, next) => {
  // Extract correlation ID from the request header or generate a new one
  const correlationId = req.headers['x-correlation-id'] || uuidv4();

  // Add it to the response headers
  res.setHeader('x-correlation-id', correlationId);

  // Add it to the request object
  req.correlationId = correlationId;

  // Create a request-specific logger
  req.logger = logger.child({ correlationId });

  req.logger.info({
    message: 'Request received',
    method: req.method,
    url: req.url
  });

  next();
});

// Routes
app.get('/', (req, res) => {
  req.logger.info('Processing home request');
  res.send('Hello World');
});

app.get('/error', (req, res) => {
  req.logger.error('Error occurred in request');
  res.status(500).send('Error');
});

app.listen(8080, () => {
  logger.info('Server started on port 8080');
});

সারাংশ

Node.js অ্যাপ্লিকেশনের ডিবাগিং, মনিটরিং এবং সমস্যা সমাধানের জন্য কার্যকরী লগিং গুরুত্বপূর্ণ
আরও ভাল অনুসন্ধান দক্ষতা এবং বিশ্লেষণের জন্য JSON ফর্ম্যাটের সাথে কাঠামোগত লগ ব্যবহার করুন
আপনার প্রয়োজনের উপর ভিত্তি করে উপযুক্ত লগিং লাইব্রেরি যেমন উইনস্টন, পিনো বা বুনিয়ান নির্বাচন করুন
সর্বোত্তম অনুশীলনগুলি ব্যবহার করুন: সঠিক লগিং স্তর ব্যবহার করুন, প্রসঙ্গ যোগ করুন এবং সংবেদনশীল ডেটা সুরক্ষিত করুন৷
উৎপাদন পরিবেশের জন্য লগ ঘূর্ণন এবং কেন্দ্রীভূত লগিং প্রয়োগ করুন
আপনার লগিং কৌশল ডিজাইন করার সময় কর্মক্ষমতা এবং নিরাপত্তা প্রভাব বিবেচনা করুন
বিতরণ করা সিস্টেমে অনুরোধ ট্র্যাক করতে যোগাযোগ আইডি ব্যবহার করুন

অনুশীলন করুন

সঠিক শব্দ চয়ন করুন।

Logging ______ allows you to categorize messages by importance.

formats
✗ ভুল! "ফরম্যাট" লগ বার্তাগুলির গঠন বোঝায়, তাত্পর্য নয়
transports
✗ ভুল! "পরিবহন" বলতে বোঝায় যেখানে রেকর্ড পাঠানো হয়
levels
✓ ঠিক আছে! "লগিং লেভেল" আপনাকে গুরুত্বের উপর ভিত্তি করে বার্তা শ্রেণীবদ্ধ করতে দেয়
contexts
✗ ভুল! "প্রসঙ্গ" অতিরিক্ত তথ্য যোগ করে, কিন্তু গুরুত্ব দ্বারা শ্রেণীবদ্ধ করে না